oracle.AWXML
Class ForecastDefinition

java.lang.Object
  |
  +--oracle.AWXML.BaseObject
        |
        +--oracle.AWXML.SolveDefinition
              |
              +--oracle.AWXML.ForecastDefinition

public class ForecastDefinition

extends SolveDefinition

A SolveDefinition that specifies forecasting instructions for a ForecastSolve. For a diagram of the class associations of ForecastSolve, see ForecastDefinition Associations.

A ForecastDefinition is owned by a Cube. A ForecastDefinition owns ForecastArgument objects that specify the forecasting method and other characteristics of the forecast. Each characteristic is represented as a keyword-value pair by a ForecastArgument. For a list of the forecast argument keywords, their valid values, and descriptions of them, see Forecast Argument Keywords and Values.

Oracle OLAP supports a number of forecasting methods, including linear and non-linear regressions, single and double exponential smoothing, and the Holt-Winters method. You can specify a method, but the Oracle OLAP determines the best method to use for your data based on past performance and overrides your choice if it is inappropriate for your data. The AUTOMATIC method, which is the default, is the best choice because it defers to the best fit.

The ForecastDefinition class includes methods for identifying the time dimension and specifying seasonal and semi-seasonal targets (if they are used by the chosen forecasting method). For more information on OLAP forecasting, see the Oracle OLAP Application Developer's Guide.

See Also:

ForecastSolve

Fields inherited from class oracle.AWXML.BaseObject

DATABASENULL

Constructor Summary

ForecastDefinition(BaseObject input)
Creates a ForecastDefinition for the specified Cube.

Method Summary

void	addForecastArgument(ForecastArgument input) Adds a ForecastArgument to the list of ForecastArgument objects owned by the ForecastDefinition.
java.lang.String	Create(AWConnection connection) Creates a ForecastDefinition in the current analytic workspace of the specified database connection.
ForecastArgument	createForecastArgument() Creates a ForecastArgument and adds it to the list of ForecastArgument objects owned by the ForecastDefinition.
java.lang.String	Delete(AWConnection connection) Deletes the ForecastDefinition in the current analytic workspace of the specified database connection.
java.util.Vector	getForecastArguments() Gets the list of ForecastArgument objects owned by the ForecastDefinition.
Measure	getSeasonalTarget() Gets the Measure that is the seasonal target for the ForecastDefinition.
Measure	getSemiSeasonalTarget() Gets the Measure that is the semi-seasonal target for the ForecastDefinition.
Dimension	getTimeDimension() Gets the Time Dimension specified for the ForecastDefinition.
void	readAWDefinitions(AWConnection connection, boolean readType) Reads the objects owned by the ForecastDefinition into memory, making them available for processing within the current analytic workspace of the specified database connection.
void	removeForecastArgument(ForecastArgument input) Removes a ForecastArgument from the list of ForecastArgument objects owned by the ForecastDefinition.
void	setSeasonalTarget(Measure input) Specifies a Measure as the seasonal target for the ForecastDefinition.
void	setSemiSeasonalTarget(Measure input) Specifies a Measure as the semi-seasonal target for the ForecastDefinition.
void	setTimeDimension(Dimension input) Specifies a Time Dimension for the ForecastDefinition.
java.lang.String	WriteToXML() Gets an XML representation of the ForecastDefinition.

Methods inherited from class oracle.AWXML.BaseObject

Alter, CreateAfter, CreateBefore, CreateFirst, DataRead, getColumnName, getId, getLongName, getLongName, getName, getOwner, getPluralName, getPluralName, getSchema, getShortName, getShortName, setColumnName, setLongName, setLongName, setName, setPluralName, setPluralName, setSchema, setShortName, setShortName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForecastDefinition

public ForecastDefinition(BaseObject input)

Creates a ForecastDefinition for the specified Cube.

Parameters:

input - The Cube to own the ForecastDefinition.

Method Detail

Create

public java.lang.String Create(AWConnection connection)

Creates a ForecastDefinition in the current analytic workspace of the specified database connection.

Overrides:

Create in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully creates the ForecastDefinition.

Delete

public java.lang.String Delete(AWConnection connection)

Deletes the ForecastDefinition in the current analytic workspace of the specified database connection.

Overrides:

Delete in class BaseObject

Parameters:

connection - The AWConnection that specifies the database connection.

Returns:

A String that contains success if this method successfully deletes the ForecastDefinition.

WriteToXML

public java.lang.String WriteToXML()

Gets an XML representation of the ForecastDefinition.

Overrides:

WriteToXML in class SolveDefinition

Returns:

An XML String that represents the ForecastDefinition.

getTimeDimension

public Dimension getTimeDimension()

Gets the Time Dimension specified for the ForecastDefinition.

Returns:

The Time Dimension for the ForecastDefinition.

setTimeDimension

public void setTimeDimension(Dimension input)

Specifies a Time Dimension for the ForecastDefinition.

Parameters:

input - The Time Dimension for the ForecastDefinition.

getSeasonalTarget

public Measure getSeasonalTarget()

Gets the Measure that is the seasonal target for the ForecastDefinition.

Returns:

The Measure that is the seasonal target for the ForecastDefinition.

setSeasonalTarget

public void setSeasonalTarget(Measure input)

Specifies a Measure as the seasonal target for the ForecastDefinition.

Parameters:

input - The Measure to specify as the seasonal target for the ForecastDefinition.

getSemiSeasonalTarget

public Measure getSemiSeasonalTarget()

Gets the Measure that is the semi-seasonal target for the ForecastDefinition.

Returns:

The Measure that is the semi-seasonal target for the ForecastDefinition.

setSemiSeasonalTarget

public void setSemiSeasonalTarget(Measure input)

Specifies a Measure as the semi-seasonal target for the ForecastDefinition.

Parameters:

input - The Measure to specify as the semi-seasonal target for the ForecastDefinition.

addForecastArgument

public void addForecastArgument(ForecastArgument input)

Adds a ForecastArgument to the list of ForecastArgument objects owned by the ForecastDefinition. A ForecastArgument has a keyword-value pair that specifies a characteristic of the forecast operation.

Parameters:

input - The ForecastArgument to add.

removeForecastArgument

public void removeForecastArgument(ForecastArgument input)

Removes a ForecastArgument from the list of ForecastArgument objects owned by the ForecastDefinition.

Parameters:

input - The ForecastArgument to remove.

getForecastArguments

public java.util.Vector getForecastArguments()

Gets the list of ForecastArgument objects owned by the ForecastDefinition.

Returns:

A Vector that contains the ForecastArgument objects owned by the ForecastDefinition.

createForecastArgument

public ForecastArgument createForecastArgument()

Creates a ForecastArgument and adds it to the list of ForecastArgument objects owned by the ForecastDefinition. A ForecastArgument has a keyword-value pair that specifies a characteristic of the forecast operation.

Returns:

The new ForecastArgument.

readAWDefinitions

public void readAWDefinitions(AWConnection connection,
                              boolean readType)

Reads the objects owned by the ForecastDefinition into memory, making them available for processing within the current analytic workspace of the specified database connection.

Parameters:

connection - The AWConnection that specifies the database connection.

readType - A boolean that specifies whether to read into memory the child objects of the ForecastDefinition. Specify true to read the ForecastDefinition and all its child objects or false to read the ForecastDefinition but omit specific child objects.